

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>Introduction &mdash; Sigil v0.4.1 documentation</title>
    <link rel="stylesheet" href="_static/custom.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.4.1',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/app_16.ico"/>
    <link rel="top" title="Sigil v0.4.1 documentation" href="index.html" />
    <link rel="next" title="The main user interface" href="main_ui.html" />
    <link rel="prev" title="Sigil documentation contents" href="contents.html" />
 
<script type="text/javascript">
  var _gaq = _gaq || [];
  _gaq.push(['_setAccount', 'UA-6767398-2']);
  _gaq.push(['_trackPageview']);
</script>

  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="main_ui.html" title="The main user interface"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="contents.html" title="Sigil documentation contents"
             accesskey="P">previous</a> |</li>
        <li><a href="contents.html">Sigil v0.4.1 documentation</a> &raquo;</li> 
      </ul>
    </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="contents.html">
              <img class="logo" src="_static/small_logo.png" alt="Logo"/>
            </a></p>
  <h3><a href="contents.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">Introduction</a><ul>
<li><a class="reference internal" href="#installation">Installation</a><ul>
<li><a class="reference internal" href="#windows">Windows</a></li>
<li><a class="reference internal" href="#linux">Linux</a></li>
<li><a class="reference internal" href="#mac-os-x">Mac OS X</a></li>
</ul>
</li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="contents.html"
                        title="previous chapter">Sigil documentation contents</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="main_ui.html"
                        title="next chapter">The main user interface</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/intro.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="introduction">
<h1>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h1>
<p><a class="reference external" href="http://code.google.com/p/sigil/">Sigil</a> is a free and open source editor for the <abbr>EPUB</abbr> format. It is designed for easy, <a class="reference internal" href="glossary.html#term-wysiwyg"><em class="xref std std-term">WYSIWYG</em></a> editing of <abbr>EPUB</abbr> files and for converting other formats to <abbr>EPUB</abbr>. It also provides features for advanced users, like direct <a class="reference internal" href="glossary.html#term-xhtml"><em class="xref std std-term">XHTML</em></a>, <a class="reference internal" href="glossary.html#term-css"><em class="xref std std-term">CSS</em></a> and <a class="reference internal" href="glossary.html#term-xpgt"><em class="xref std std-term">XPGT</em></a> editing. You can use it to add any of the metadata entries supported by the <abbr>EPUB</abbr> specification and create a hierarchical Table of Contents.</p>
<p>The editor works on all three major platforms: Windows, Linux and Mac OS X.</p>
<p>Sigil is a work in progress, and as such is still missing many features. If you have the programming skills, you can directly contribute to its development. Even if you don&#8217;t, just using Sigil and reporting any bugs or missing features on the <a class="reference external" href="http://code.google.com/p/sigil/issues/list">issue tracker</a> will go a long way towards making it a better application for everyone.</p>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>Installing Sigil is fairly easy on all platforms. The files can be downloaded from the <a class="reference external" href="http://code.google.com/p/sigil/downloads/list">download section</a> of the project site.</p>
<div class="section" id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
<p>On Windows, you merely run the the appropriate installer. If you have a 64 bit version of Windows, you should use the Windows installer labeled with <tt class="docutils literal"><span class="pre">x86_64</span></tt>. Otherwise, use the vanilla one.</p>
<p>Then just run it. Everything should take care of itself. If you get an &#8220;application configuration is incorrect&#8221; message when starting Sigil, see <a class="reference external" href="http://code.google.com/p/sigil/wiki/FAQ#I_am_running_Windows_and_I_get_an_%22application_configuratio">this item</a> in the <abbr>FAQ</abbr>.</p>
<p>Sigil is tested on XP, Vista x64 and Windows 7 x64.</p>
</div>
<div class="section" id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
<p>Run the installer for your <abbr>CPU</abbr> architecture. Two are available: <tt class="docutils literal"><span class="pre">x86</span></tt> and <tt class="docutils literal"><span class="pre">x86_64</span></tt>. If in doubt, use the <tt class="docutils literal"><span class="pre">x86</span></tt> one. The <a class="reference external" href="http://qt.nokia.com/products">Qt Framework</a> is included in the installer.</p>
<p>You have to do this from the console. First, make the installer executable and then run it:</p>
<div class="highlight-bash"><div class="highlight"><pre>chmod +x installer.bin
sudo ./installer.bin
</pre></div>
</div>
<p>After the installer completes, there should be an icon on your desktop and an entry in your &#8220;start menu&#8221;.</p>
<p>Sigil can be uninstalled by running the <tt class="docutils literal"><span class="pre">uninstall</span></tt> executable located in the folder in which Sigil was installed. By default, this is <tt class="docutils literal"><span class="pre">/opt/sigil</span></tt>. So with default options, uninstalling Sigil would look like this:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">cd</span> /opt/sigil
sudo ./uninstall
</pre></div>
</div>
<p>Sigil is tested on Ubuntu 9.10 (Karmic Koala).</p>
</div>
<div class="section" id="mac-os-x">
<h3>Mac OS X<a class="headerlink" href="#mac-os-x" title="Permalink to this headline">¶</a></h3>
<p>Unpack the DMG file and drag the <tt class="docutils literal"><span class="pre">Sigil.app</span></tt> file to your <tt class="docutils literal"><span class="pre">Applications</span></tt> folder.</p>
<p>Sigil is built as a universal binary, and is tested on Mac OS X 10.5 and 10.6. Sigil should also work on Tiger (10.4), but is untested on that version of Mac OS X.</p>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="main_ui.html" title="The main user interface"
             >next</a> |</li>
        <li class="right" >
          <a href="contents.html" title="Sigil documentation contents"
             >previous</a> |</li>
        <li><a href="contents.html">Sigil v0.4.1 documentation</a> &raquo;</li> 
      </ul>
    </div>

    <div class="footer">
        &copy; Copyright 2009-2011, Strahinja Marković.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
<script type="text/javascript">
  (function() {
    var ga = document.createElement('script');
    ga.src = ('https:' == document.location.protocol ?
              'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
    ga.setAttribute('async', 'true');
    document.documentElement.firstChild.appendChild(ga);
  })();
</script>

  </body>
</html>